xfi:fact-explicit-dimension-value

  1. The XBRL Standard
  2. XBRL Specifications
  3. Registries
  4. Functions Registry 1.0
  5. Functions Registry
  6. xfi:fact-explicit-dimension-value

xs:QName?=xfi:fact-explicit-dimension-value( $item as schema-element(xbrli:item), $dimension as xs:QName)

Last updated on 22-05-2008 at 00:00:00.

Returns the QName, if any, of the member reported for the dimension in either the segment or scenario of the supplied item.

OIM Status

Deprecated - this function may be used in OIM-compatible Formula Rules, but its use is not recommended.

Parameters

Name Type Details
item schema-element(xbrli:item) The item that the dimension value is required for.
dimension xs:QName The QName of the dimension that the value is required for.

Output

Type: xs:QName?

Returns the QName of the value for the dimension that is reported in the segment or scenario of the item and the empty sequence if the dimension is not reported for the item and no default is applicable.

The dimension default is deemed applicable when the dimension is not reported for the item, regardless of the dimensional validity of this default value for the item (e.g., the default is reported even when the primary item concept, of an item lacking the dimension, is in a closed hypercube that does not allow the dimension or does not allow the default member).

Errors

Code Details
xfie:invalidExplicitDimensionQName This error MUST be thrown if the dimension does not specify an explicit dimension in the reference discoverable taxonomy set.

Conformance suite

90309 xfi.fact-explicit-dimension-value testcase.xml [ download ]

Owners

Name Affiliation Email Start End
Geoff Shuetrim Galexy geoff@galexy.net 05-02-2008 at 00:00:00
Herm Fischer UBMatrix / Mark V Systems fischer@markv.com 01-09-2008 at 00:00:00

Revisions

Name On Details
Geoff Shuetrim 05-02-2008 at 10:54:00 Created the function definition.
Geoff Shuetrim 27-02-2008 at 00:00:00 Made the function specific to segments.
Herm Fischer 15-04-2008 at 00:00:00 Renamed invalidSegmentDimensionForFact to invalidDimensionForFact upon advice from Fujitsu for consistency.
Herm Fischer 22-05-2008 at 00:00:00 Added note and testcase that default values are reportable.
Herm Fischer 01-09-2008 at 00:00:00 Made the function segment/scenario agnostic, renamed without segment/scenario in name.
Geoff Shuetrim 13-11-2008 at 00:00:00 Removed the xfie:invalidDimensionForFact error code because any such problems are expected to be detected by pre-processing validation of the instance containing the fact.
Herm Fischer 01-03-2011 at 16:00:00 Clarified that dimension default values are reported for a dimension without respect to such a default value's validity for a given primary item.